home *** CD-ROM | disk | FTP | other *** search
/ Magazyn WWW 2000 June / www-06-2000.iso / prog / mac / zwrite / tucows_zwrite.hqx / zwrite Folder / Bug Reporter Folder / Bug Reporter Instructions next >
Text File  |  1999-06-10  |  3KB  |  118 lines
  1. Bug Reporter 1.0
  2. by Marc Zeedar
  3. Copyright ⌐1999 by Stone Table Software
  4. All Rights Reserved
  5.  
  6.  
  7. In Brief
  8. Bug Reporter is a simple application for assisting you in your beta-testing duties. When you find a bug or have a feature suggestion, run Bug Reporter and it will help you create a new text file which you can e-mail to <sts-bugs@designwrite.com>. Bug Reporter will ensure that you don╒t forget any important information.
  9.  
  10. Usage
  11. Bug Reporter has three screens: Preferences, Report Configuration window, and a Report window. Before you can use Bug Reporter, you must fill in the information about yourself and your computer in the Preferences dialog:
  12.  
  13. ╩
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38. Once you╒ve filled in your preferences, they are saved for reuse the next time you launch Bug Reporter. You shouldn╒t have to change the Preferences again unless your system changes.
  39.  
  40. The main window of Bug Reporter is the Report Configuration screen:
  41.  
  42. ╩
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65. This is where you specify the subject of your message, the type of bug, the release number of the beta software you are using (very important), and a description of the problem and any workarounds or solutions.  When you choose ╥New Report╙ from the File Menu, this is the screen that is created. You may create several reports at once, if you wish, but there is only one Report Window (see below).
  66.  
  67. When you╒ve filled out the required fields, the ╥Generate Report╙ button is enabled. (NOTE: the button will never be enabled if you haven╒t completed the required Preferences information.)
  68.  
  69. When you press the ╥Generate Report╙ button, Bug Reporter will display the Report Window and fill in all the information of your report. You are free to edit this, if you need. Please try not to change the formatting too much or delete important information. The purpose of Bug Reporter is simply to make the process of gathering this info easier for you.
  70.  
  71. Here is what a typical report looks like:
  72.  
  73. ╩
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105. Sending Your Report
  106. When your report is satisfactory, you can either copy and paste into an e-mail message in your favorite e-mail application, or you can save the message to disk as a Simpletext file for sending later.
  107.  
  108. Important: send all bug reports to <sts-bugs@designwrite.com>. I get lots of e-mail, and it╒s important it gets filtered correctly or it will severely delay my response to your bug. If you sent your report to the correct address, you should receive a confirmation response within 24 hours (usually less, but who knows). The automated confirmation just lets you know I received your report. If needed, I may follow up with you personally at a later time.
  109.  
  110. If you find problems with Bug Reporter, send them to the same address: just change the product name to ╥Bug Reporter.╙
  111.  
  112.  
  113. Stone Table Software
  114. PO Box 66831
  115. Scotts Valley, CA 95067
  116. sts@designwrite.com
  117. <http://www.designwrite.com/sts/index.html>
  118.